<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wickr-crypto-c: src/wickrcrypto/include/wickrcrypto/stream_key.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">wickr-crypto-c
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_92a70b6cc7e213c660915fdf1190028f.html">wickrcrypto</a></li><li class="navelem"><a class="el" href="dir_db4377ef08cfba82f5e7141624102360.html">include</a></li><li class="navelem"><a class="el" href="dir_2adb4122f2f58e588d09641dee9865e2.html">wickrcrypto</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">stream_key.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright © 2012-2018 Wickr Inc.  All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * This code is being released for EDUCATIONAL, ACADEMIC, AND CODE REVIEW PURPOSES</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * ONLY.  COMMERCIAL USE OF THE CODE IS EXPRESSLY PROHIBITED.  For additional details,</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * please see LICENSE</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * THE CODE IS MADE AVAILABLE &quot;AS-IS&quot; AND WITHOUT ANY EXPRESS OR</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * IMPLIED GUARANTEES AS TO FITNESS, MERCHANTABILITY, NON-</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * INFRINGEMENT OR OTHERWISE. IT IS NOT BEING PROVIDED IN TRADE BUT ON</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * A VOLUNTARY BASIS ON BEHALF OF THE AUTHOR’S PART FOR THE BENEFIT</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * OF THE LICENSEE AND IS NOT MADE AVAILABLE FOR CONSUMER USE OR ANY</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * OTHER USE OUTSIDE THE TERMS OF THIS LICENSE. ANYONE ACCESSING THE</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * CODE SHOULD HAVE THE REQUISITE EXPERTISE TO SECURE THEIR SYSTEM</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * AND DEVICES AND TO ACCESS AND USE THE CODE FOR REVIEW PURPOSES</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * ONLY. LICENSEE BEARS THE RISK OF ACCESSING AND USING THE CODE. IN</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * PARTICULAR, AUTHOR BEARS NO LIABILITY FOR ANY INTERFERENCE WITH OR</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * ADVERSE EFFECT THAT MAY OCCUR AS A RESULT OF THE LICENSEE</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * ACCESSING AND/OR USING THE CODE ON LICENSEE’S SYSTEM.</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#ifndef stream_key_h</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#define stream_key_h</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &quot;crypto_engine.h&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#define PACKET_PER_EVO_MIN 64</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#define PACKET_PER_EVO_DEFAULT 512</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#define PACKET_PER_EVO_MAX 32768</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structwickr__stream__key.html">   56</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structwickr__stream__key.html">wickr_stream_key</a> {</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structwickr__stream__key.html#a3d957a51193dda882cb89ced2ceeb91e">   57</a></span>&#160;    <a class="code" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *<a class="code" href="structwickr__stream__key.html#a3d957a51193dda882cb89ced2ceeb91e">cipher_key</a>;</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structwickr__stream__key.html#ae7210bd67e61cb4c38733a237dae95d9">   58</a></span>&#160;    <a class="code" href="structwickr__buffer.html">wickr_buffer_t</a> *<a class="code" href="structwickr__stream__key.html#ae7210bd67e61cb4c38733a237dae95d9">evolution_key</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structwickr__stream__key.html#a51e59da9f7fbb0b3e1332a20252d1cc6">   59</a></span>&#160;    <a class="code" href="structwickr__buffer.html">wickr_buffer_t</a> *<a class="code" href="structwickr__stream__key.html#a51e59da9f7fbb0b3e1332a20252d1cc6">user_data</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structwickr__stream__key.html#a78777e4c64048b6dae38f8772744194e">   60</a></span>&#160;    uint32_t <a class="code" href="structwickr__stream__key.html#a78777e4c64048b6dae38f8772744194e">packets_per_evolution</a>;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;};</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structwickr__stream__key.html">wickr_stream_key</a> <a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a>;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> *<a class="code" href="group__wickr__stream__key.html#ga54449667a25d9e64cd04dae58dd76418">wickr_stream_key_create</a>(<a class="code" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *<a class="code" href="structwickr__stream__key.html#a3d957a51193dda882cb89ced2ceeb91e">cipher_key</a>, <a class="code" href="structwickr__buffer.html">wickr_buffer_t</a> *<a class="code" href="structwickr__stream__key.html#ae7210bd67e61cb4c38733a237dae95d9">evolution_key</a>, uint32_t <a class="code" href="structwickr__stream__key.html#a78777e4c64048b6dae38f8772744194e">packets_per_evolution</a>);</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> *<a class="code" href="group__wickr__stream__key.html#gaff8e766f3519e9e73157938bd1d3e024">wickr_stream_key_create_user_data</a>(<a class="code" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *<a class="code" href="structwickr__stream__key.html#a3d957a51193dda882cb89ced2ceeb91e">cipher_key</a>, <a class="code" href="structwickr__buffer.html">wickr_buffer_t</a> *<a class="code" href="structwickr__stream__key.html#ae7210bd67e61cb4c38733a237dae95d9">evolution_key</a>, uint32_t <a class="code" href="structwickr__stream__key.html#a78777e4c64048b6dae38f8772744194e">packets_per_evolution</a>, <a class="code" href="structwickr__buffer.html">wickr_buffer_t</a> *<a class="code" href="structwickr__stream__key.html#a51e59da9f7fbb0b3e1332a20252d1cc6">user_data</a>);</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> *<a class="code" href="group__wickr__stream__key.html#ga9e95dd486dbe2f3db647c65042601b34">wickr_stream_key_create_rand</a>(<span class="keyword">const</span> <a class="code" href="structwickr__crypto__engine.html">wickr_crypto_engine_t</a> engine, <a class="code" href="structwickr__cipher.html">wickr_cipher_t</a> cipher, uint32_t <a class="code" href="structwickr__stream__key.html#a78777e4c64048b6dae38f8772744194e">packets_per_evolution</a>);</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> *<a class="code" href="group__wickr__stream__key.html#ga0201dd73adf773834d7dbb4bbc307fae">wickr_stream_key_copy</a>(<span class="keyword">const</span> <a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> *stream_key);</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<a class="code" href="structwickr__buffer.html">wickr_buffer_t</a> *<a class="code" href="group__wickr__stream__key.html#gae1540c98a88e2f62e96fb2ee209e2290">wickr_stream_key_serialize</a>(<span class="keyword">const</span> <a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> *key);</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> *<a class="code" href="group__wickr__stream__key.html#gadf1565329fed927531e1a14334ed23e4">wickr_stream_key_create_from_buffer</a>(<span class="keyword">const</span> <a class="code" href="structwickr__buffer.html">wickr_buffer_t</a> *buffer);</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__wickr__stream__key.html#ga3bb3dec760c5b7f3a1bd2d0bb13bcc79">wickr_stream_key_destroy</a>(<a class="code" href="structwickr__stream__key.html">wickr_stream_key_t</a> **stream_key);</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;}</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* stream_key_h */</span><span class="preprocessor"></span></div><div class="ttc" id="group__wickr__stream__key_html_ga3bb3dec760c5b7f3a1bd2d0bb13bcc79"><div class="ttname"><a href="group__wickr__stream__key.html#ga3bb3dec760c5b7f3a1bd2d0bb13bcc79">wickr_stream_key_destroy</a></div><div class="ttdeci">void wickr_stream_key_destroy(wickr_stream_key_t **stream_key)</div></div>
<div class="ttc" id="group__wickr__stream__key_html_ga9e95dd486dbe2f3db647c65042601b34"><div class="ttname"><a href="group__wickr__stream__key.html#ga9e95dd486dbe2f3db647c65042601b34">wickr_stream_key_create_rand</a></div><div class="ttdeci">wickr_stream_key_t * wickr_stream_key_create_rand(const wickr_crypto_engine_t engine, wickr_cipher_t cipher, uint32_t packets_per_evolution)</div></div>
<div class="ttc" id="group__wickr__stream__key_html_gaff8e766f3519e9e73157938bd1d3e024"><div class="ttname"><a href="group__wickr__stream__key.html#gaff8e766f3519e9e73157938bd1d3e024">wickr_stream_key_create_user_data</a></div><div class="ttdeci">wickr_stream_key_t * wickr_stream_key_create_user_data(wickr_cipher_key_t *cipher_key, wickr_buffer_t *evolution_key, uint32_t packets_per_evolution, wickr_buffer_t *user_data)</div></div>
<div class="ttc" id="structwickr__buffer_html"><div class="ttname"><a href="structwickr__buffer.html">wickr_buffer</a></div><div class="ttdoc">Represents an array of bytes and the length of the allocation associated with those bytes.</div><div class="ttdef"><b>Definition:</b> buffer.h:51</div></div>
<div class="ttc" id="structwickr__stream__key_html_a51e59da9f7fbb0b3e1332a20252d1cc6"><div class="ttname"><a href="structwickr__stream__key.html#a51e59da9f7fbb0b3e1332a20252d1cc6">wickr_stream_key::user_data</a></div><div class="ttdeci">wickr_buffer_t * user_data</div><div class="ttdef"><b>Definition:</b> stream_key.h:59</div></div>
<div class="ttc" id="structwickr__stream__key_html_ae7210bd67e61cb4c38733a237dae95d9"><div class="ttname"><a href="structwickr__stream__key.html#ae7210bd67e61cb4c38733a237dae95d9">wickr_stream_key::evolution_key</a></div><div class="ttdeci">wickr_buffer_t * evolution_key</div><div class="ttdef"><b>Definition:</b> stream_key.h:58</div></div>
<div class="ttc" id="group__wickr__stream__key_html_ga54449667a25d9e64cd04dae58dd76418"><div class="ttname"><a href="group__wickr__stream__key.html#ga54449667a25d9e64cd04dae58dd76418">wickr_stream_key_create</a></div><div class="ttdeci">wickr_stream_key_t * wickr_stream_key_create(wickr_cipher_key_t *cipher_key, wickr_buffer_t *evolution_key, uint32_t packets_per_evolution)</div></div>
<div class="ttc" id="structwickr__cipher_html"><div class="ttname"><a href="structwickr__cipher.html">wickr_cipher</a></div><div class="ttdoc">Represents a cipher that can be used in the crypto_engine. This meta object holds parameters for the ...</div><div class="ttdef"><b>Definition:</b> cipher.h:56</div></div>
<div class="ttc" id="group__wickr__stream__key_html_gae1540c98a88e2f62e96fb2ee209e2290"><div class="ttname"><a href="group__wickr__stream__key.html#gae1540c98a88e2f62e96fb2ee209e2290">wickr_stream_key_serialize</a></div><div class="ttdeci">wickr_buffer_t * wickr_stream_key_serialize(const wickr_stream_key_t *key)</div></div>
<div class="ttc" id="structwickr__stream__key_html_a3d957a51193dda882cb89ced2ceeb91e"><div class="ttname"><a href="structwickr__stream__key.html#a3d957a51193dda882cb89ced2ceeb91e">wickr_stream_key::cipher_key</a></div><div class="ttdeci">wickr_cipher_key_t * cipher_key</div><div class="ttdef"><b>Definition:</b> stream_key.h:57</div></div>
<div class="ttc" id="structwickr__stream__key_html"><div class="ttname"><a href="structwickr__stream__key.html">wickr_stream_key</a></div><div class="ttdoc">A data structure representing the stream encoding / decoding key material A stream key holds informat...</div><div class="ttdef"><b>Definition:</b> stream_key.h:56</div></div>
<div class="ttc" id="structwickr__cipher__key_html"><div class="ttname"><a href="structwickr__cipher__key.html">wickr_cipher_key</a></div><div class="ttdef"><b>Definition:</b> cipher.h:189</div></div>
<div class="ttc" id="group__wickr__stream__key_html_ga0201dd73adf773834d7dbb4bbc307fae"><div class="ttname"><a href="group__wickr__stream__key.html#ga0201dd73adf773834d7dbb4bbc307fae">wickr_stream_key_copy</a></div><div class="ttdeci">wickr_stream_key_t * wickr_stream_key_copy(const wickr_stream_key_t *stream_key)</div></div>
<div class="ttc" id="group__wickr__stream__key_html_gadf1565329fed927531e1a14334ed23e4"><div class="ttname"><a href="group__wickr__stream__key.html#gadf1565329fed927531e1a14334ed23e4">wickr_stream_key_create_from_buffer</a></div><div class="ttdeci">wickr_stream_key_t * wickr_stream_key_create_from_buffer(const wickr_buffer_t *buffer)</div></div>
<div class="ttc" id="structwickr__crypto__engine_html"><div class="ttname"><a href="structwickr__crypto__engine.html">wickr_crypto_engine</a></div><div class="ttdoc">Interface to a set of cryptographic operations used throughout the library. Currently the default imp...</div><div class="ttdef"><b>Definition:</b> crypto_engine.h:53</div></div>
<div class="ttc" id="structwickr__stream__key_html_a78777e4c64048b6dae38f8772744194e"><div class="ttname"><a href="structwickr__stream__key.html#a78777e4c64048b6dae38f8772744194e">wickr_stream_key::packets_per_evolution</a></div><div class="ttdeci">uint32_t packets_per_evolution</div><div class="ttdef"><b>Definition:</b> stream_key.h:60</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
